You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR improves the checks around release notes in pull requests by updating the error message in the release notes checking script. The new message clarifies that, aside from the internal label (which does not require release notes), all other pull requests must include a descriptive release notes section.
Additionally, the PR modifies the GitHub Action workflow for release notes checks by changing the permission for pull-requests from read to write. This adjustment likely enables the workflow to create issue comments or perform other write operations on pull request objects, ensuring that the updated message can be correctly posted as a comment on the PR.
Test Suggestions
Verify that a pull request with the required non-internal label but missing a valid release notes description triggers the new error message.
Test that a pull request labeled internal bypasses the requirement for a release notes description.
Check that the GitHub Action workflow successfully posts an issue comment when the release notes check fails.
Ensure that the workflow's elevated pull-requests permission does not introduce any unintended side effects by validating the scope of its access.
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You have signed the CLA already but the status is still pending? Let us recheck it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
internalNot to be externalized in the release notes
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
What and why?
It looks like there might be another issue with the release notes workflow in that it needs better permissions to output a comment with instructions:
How to test
What needs special review?
Dependencies, breaking changes, and deployment notes
Release notes
Checklist